Add discriminated union serialization tests - #1860
Open
jar-stripe wants to merge 2 commits into
Open
Conversation
Tests discriminated union type shapes for both request-side (TypedDict params with Literal discriminator) and response-side (StripeObject deserialization), covering standalone and inline variants. Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com> Committed-By-Agent: claude
jar-stripe
marked this pull request as ready for review
August 6, 2026 21:13
jar-stripe
requested review from
xavdid
and
a lite review from Copilot
and removed request for
a team
August 6, 2026 21:13
There was a problem hiding this comment.
Pull request overview
Adds a new test module intended to validate “discriminated union” payload shapes, covering both request-style dict params (TypedDict + Literal discriminator) and response-style StripeObject construct/to_dict round-trips.
Changes:
- Introduces standalone and inline discriminator “union” examples via
TypedDictvariants. - Adds runtime tests for discriminator field presence/access on dict params and
StripeObjectinstances. - Adds round-trip checks ensuring discriminator fields survive
construct_from(...).to_dict().
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
Comment on lines
+289
to
+291
| params: RgbColorParams = {"model": "rgb", "r": 200, "g": 100, "b": 50} | ||
| # Simulating what the SDK does when encoding params for an API request. | ||
| serialized = dict(params) |
Comment on lines
+1
to
+11
| """ | ||
| Tests for discriminated union type shapes. | ||
|
|
||
| Covers both sides of the API boundary: | ||
| - Request side: TypedDict params with Literal discriminator fields | ||
| - Response side: StripeObject deserialization from JSON with a discriminator | ||
|
|
||
| Two structural patterns are tested: | ||
| - Standalone union: the discriminated union is its own type (e.g. ColorParams) | ||
| - Inline union: the discriminator lives at the parent object level (e.g. shape.type) | ||
| """ |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Why?
Validates that the discriminated union type shapes work correctly in stripe-python before codegen produces these patterns. Covers both request-side (TypedDict params with Literal discriminator) and response-side (StripeObject deserialization).
What?
tests/test_discriminated_unions.pywith 36 tests covering:Literal["value"]discriminator field (request side)StripeObject.construct_fromfor both patternsSee Also